<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>SQL JDBC | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="xpack-sql.html" title="SQL access">
<link rel="prev" href="sql-cli.html" title="SQL CLI">
<link rel="next" href="_api_usage.html" title="API usage">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="xpack-sql.html">SQL access</a></span>
»
<span class="breadcrumb-node">SQL JDBC</span>
</div>
<div class="navheader">
<span class="prev">
<a href="sql-cli.html">« SQL CLI</a>
</span>
<span class="next">
<a href="_api_usage.html">API usage »</a>
</span>
</div>
<div class="chapter xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="sql-jdbc"></a>SQL JDBC<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a><a class="xpack_tag" href="/subscriptions"></a>
</h2>
</div></div></div>
<p>Elasticsearch’s SQL jdbc driver is a rich, fully featured JDBC driver for Elasticsearch.
It is Type 4 driver, meaning it is a platform independent, stand-alone, Direct to Database,
pure Java driver that converts JDBC calls to Elasticsearch SQL.</p>
<h3>
<a id="sql-jdbc-installation"></a>Installation<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h3>
<p>The JDBC driver can be obtained from:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
Dedicated page
</span>
</dt>
<dd>
<a href="/downloads/jdbc-client" class="ulink" target="_top">elastic.co</a> provides links, typically for manual downloads.
</dd>
<dt>
<span class="term">
Maven dependency
</span>
</dt>
<dd>
<a href="http://maven.apache.org/" class="ulink" target="_top">Maven</a>-compatible tools can retrieve it automatically as a dependency:
</dd>
</dl>
</div>
<div class="pre_wrapper lang-xml">
<pre class="programlisting prettyprint lang-xml">&lt;dependency&gt;
  &lt;groupId&gt;org.elasticsearch.plugin&lt;/groupId&gt;
  &lt;artifactId&gt;x-pack-sql-jdbc&lt;/artifactId&gt;
  &lt;version&gt;7.7.1&lt;/version&gt;
&lt;/dependency&gt;</pre>
</div>
<p>from <code class="literal">artifacts.elastic.co/maven</code> by adding it to the repositories list:</p>
<div class="pre_wrapper lang-xml">
<pre class="programlisting prettyprint lang-xml">&lt;repositories&gt;
  &lt;repository&gt;
    &lt;id&gt;elastic.co&lt;/id&gt;
    &lt;url&gt;https://artifacts.elastic.co/maven&lt;/url&gt;
  &lt;/repository&gt;
&lt;/repositories&gt;</pre>
</div>
<h3>
<a id="jdbc-setup"></a>Setup<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h3>
<p>The driver main class is <code class="literal">org.elasticsearch.xpack.sql.jdbc.EsDriver</code>.
Note the driver  implements the JDBC 4.0 <code class="literal">Service Provider</code> mechanism meaning it is registered automatically
as long as it is available in the classpath.</p>
<p>Once registered, the driver understands the following syntax as an URL:</p>
<div class="pre_wrapper lang-text">
<pre class="programlisting prettyprint lang-text">jdbc:es://[[http|https]://]?[host[:port]]?/[prefix]?[\?[option=value]&amp;]*</pre>
</div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">jdbc:es://</code>
</span>
</dt>
<dd>
Prefix. Mandatory.
</dd>
<dt>
<span class="term">
<code class="literal">[[http|https]://]</code>
</span>
</dt>
<dd>
Type of HTTP connection to make. Possible values are
<code class="literal">http</code> (default) or <code class="literal">https</code>. Optional.
</dd>
<dt>
<span class="term">
<code class="literal">[host[:port]]</code>
</span>
</dt>
<dd>
Host (<code class="literal">localhost</code> by default) and port (<code class="literal">9200</code> by default).
Optional.
</dd>
<dt>
<span class="term">
<code class="literal">[prefix]</code>
</span>
</dt>
<dd>
Prefix (empty by default). Typically used when hosting Elasticsearch under
a certain path. Optional.
</dd>
<dt>
<span class="term">
<code class="literal">[option=value]</code>
</span>
</dt>
<dd>
Properties for the JDBC driver. Empty by default.
Optional.
</dd>
</dl>
</div>
<p>The driver recognized the following properties:</p>
<h5>
<a id="jdbc-cfg"></a>Essential<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h5>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">timezone</code> (default JVM timezone)
</span>
</dt>
<dd>
Timezone used by the driver <em>per connection</em> indicated by its <code class="literal">ID</code>.
<span class="strong strong"><strong>Highly</strong></span> recommended to set it (to, say, <code class="literal">UTC</code>) as the JVM timezone can vary, is global for the entire JVM and can’t be changed easily when running under a security manager.
</dd>
</dl>
</div>
<h5>
<a id="jdbc-cfg-network"></a>Network<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h5>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">connect.timeout</code> (default 30s)
</span>
</dt>
<dd>
Connection timeout (in seconds). That is the maximum amount of time waiting to make a connection to the server.
</dd>
<dt>
<span class="term">
<code class="literal">network.timeout</code> (default 60s)
</span>
</dt>
<dd>
Network timeout (in seconds). That is the maximum amount of time waiting for the network.
</dd>
<dt>
<span class="term">
<code class="literal">page.timeout</code> (default 45s)
</span>
</dt>
<dd>
Page timeout (in seconds). That is the maximum amount of time waiting for a page.
</dd>
<dt>
<span class="term">
<code class="literal">page.size</code> (default 1000)
</span>
</dt>
<dd>
Page size (in entries). The number of results returned per page by the server.
</dd>
<dt>
<span class="term">
<code class="literal">query.timeout</code> (default 90s)
</span>
</dt>
<dd>
Query timeout (in seconds). That is the maximum amount of time waiting for a query to return.
</dd>
</dl>
</div>
<h4>
<a id="jdbc-cfg-auth"></a>Basic Authentication<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h4>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">user</code>
</span>
</dt>
<dd>
Basic Authentication user name
</dd>
<dt>
<span class="term">
<code class="literal">password</code>
</span>
</dt>
<dd>
Basic Authentication password
</dd>
</dl>
</div>
<h4>
<a id="jdbc-cfg-ssl"></a>SSL<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h4>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">ssl</code> (default false)
</span>
</dt>
<dd>
Enable SSL
</dd>
<dt>
<span class="term">
<code class="literal">ssl.keystore.location</code>
</span>
</dt>
<dd>
key store (if used) location
</dd>
<dt>
<span class="term">
<code class="literal">ssl.keystore.pass</code>
</span>
</dt>
<dd>
key store password
</dd>
<dt>
<span class="term">
<code class="literal">ssl.keystore.type</code> (default <code class="literal">JKS</code>)
</span>
</dt>
<dd>
key store type. <code class="literal">PKCS12</code> is a common, alternative format
</dd>
<dt>
<span class="term">
<code class="literal">ssl.truststore.location</code>
</span>
</dt>
<dd>
trust store location
</dd>
<dt>
<span class="term">
<code class="literal">ssl.truststore.pass</code>
</span>
</dt>
<dd>
trust store password
</dd>
<dt>
<span class="term">
<code class="literal">ssl.truststore.type</code> (default <code class="literal">JKS</code>)
</span>
</dt>
<dd>
trust store type. <code class="literal">PKCS12</code> is a common, alternative format
</dd>
<dt>
<span class="term">
<code class="literal">ssl.protocol</code>(default <code class="literal">TLS</code>)
</span>
</dt>
<dd>
SSL protocol to be used
</dd>
</dl>
</div>
<h4>
<a id="_proxy"></a>Proxy<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h4>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">proxy.http</code>
</span>
</dt>
<dd>
Http proxy host name
</dd>
<dt>
<span class="term">
<code class="literal">proxy.socks</code>
</span>
</dt>
<dd>
SOCKS proxy host name
</dd>
</dl>
</div>
<h4>
<a id="_mapping"></a>Mapping<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h4>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">field.multi.value.leniency</code> (default <code class="literal">true</code>)
</span>
</dt>
<dd>
Whether to be lenient and return the first value (without any guarantees of what that
will be - typically the first in natural ascending order) for fields with multiple values (true) or throw an exception.
</dd>
</dl>
</div>
<h4>
<a id="_index"></a>Index<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h4>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">index.include.frozen</code> (default <code class="literal">false</code>)
</span>
</dt>
<dd>
Whether to include <a class="xref" href="frozen-indices.html" title="Frozen indices">frozen-indices</a> in the query execution or not (default).
</dd>
</dl>
</div>
<h4>
<a id="_additional"></a>Additional<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/sql/endpoints/jdbc.asciidoc">edit</a>
</h4>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">validate.properties</code> (default true)
</span>
</dt>
<dd>
If disabled, it will ignore any misspellings or unrecognizable properties. When enabled, an exception
will be thrown if the provided property cannot be recognized.
</dd>
</dl>
</div>
<p>To put all of it together, the following URL:</p>
<div class="pre_wrapper lang-text">
<pre class="programlisting prettyprint lang-text">jdbc:es://http://server:3456/?timezone=UTC&amp;page.size=250</pre>
</div>
<p>Opens up a Elasticsearch SQL connection to <code class="literal">server</code> on port <code class="literal">3456</code>, setting the JDBC connection timezone to <code class="literal">UTC</code> and its pagesize to <code class="literal">250</code> entries.</p>

</div>
<div class="navfooter">
<span class="prev">
<a href="sql-cli.html">« SQL CLI</a>
</span>
<span class="next">
<a href="_api_usage.html">API usage »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
